v1.5.0: Swift-DocC-Plugin 1.5.0

Compare Source

What's Changed

• Support extracting snippets and snippet slices for many new programming languages.

The 1.5.0 release includes contributions from @​ktoso. Thank you!

v1.4.6: Swift-DocC-Plugin 1.4.6

Compare Source

What's Changed

• Add .gitattributes for symlinks on Windows.
• Add .github/CODEOWNERS file.
• Fix multiple typos across the codebase.

The 1.4.6 release includes contributions from @​kcieplak, @​MojtabaHs, and @​shahmishal. Thank you!

v1.4.5: Swift-DocC-Plugin 1.4.5

Compare Source

What's Changed

• Fix build errors on FreeBSD.

The 1.4.5 release includes contributions from @​jakepetroules. Thank you!

v1.4.4: Swift-DocC-Plugin 1.4.4

Compare Source

What's Changed

• Fix build errors on Android.
• Fix Swift 6.2 code warnings about non-sendable types in isolated closures.

The 1.4.4 release includes contributions from @​finagolfin and @​d-ronnqvist. Thank you!

v1.4.3: Swift-DocC-Plugin 1.4.3

Compare Source

What's Changed

• Fixes a bug with the experimental combined documentation feature where targets with multiple dependencies wasn't able to link to all their dependencies' documentation.

• Support generating Swift documentation for C/C++/Objective-C targets.

The 1.4.3 release includes contributions from @​cmcgee1024, @​sofiaromorales, and @​d-ronnqvist. Thank you!

v1.4.2: Swift-DocC-Plugin 1.4.2

Compare Source

What's Changed

Fixes a build failure for Swift versions 5.7 and 5.8.

Swift versions 5.6 and earlier are not supported, and Package.swift now reflects this as expected.

v1.4.1: Swift-DocC-Plugin 1.4.1

Compare Source

What's changed

This fixes a build failure with Swift version 5.10.

v1.4.0: Swift-DocC-Plugin 1.4.0

Compare Source

What's Changed

• You can now customize the minimal access level of symbols to include in your documentation. The default access level continues to be "public" for libraries and "internal" for executables. To specify a custom minimal access level, pass the new --symbol-graph-minimum-access-level flag:

  swift package generate documentation \
    --symbol-graph-minimum-access-level internal \
    --target [target-name]
  

• You can now generate a combined documentation archive with the documentation for multiple targets when building with Swift 6.0 or later. Each target's documentation can link to its target dependencies' documentation. This is an opt-in, experimental feature that can used by passing the --enable-experimental-combined-documentation flag:

  swift package generate documentation \
    --enable-experimental-combined-documentation \
    --target [first-target-name] \
    --target [second-target-name] \
  

• Using a custom --output-path when building documentation for more than one target no longer causes one target to write over the output of the other target. Instead, both targets write their output in subdirectories of the specified output path. When building documentation for a single target, or when building combined documentation, the plugin continues to write the output directly to the specified output path.

• The help text in swift package generate-documentation --help now includes information about all the DocC options. The help text also organizes the symbol graph options into its own section.

The 1.4.0 release includes contributions from @​natikgadzhi, @​d-ronnqvist, @​JessyCatterwaul, @​joey-gm, @​dabrahams, @​parispittman, @​SwiftCoderJoe, and @​Kyle-Ye. Thank you!

v1.3.0: Swift-DocC-Plugin 1.3.0

Compare Source

What's Changed

• Documentation for Swift symbols that extend other modules is now included by default when building with Swift 5.9 or later. To exclude external types when building Swift 5.9 or later, you can pass the new --exclude-extended-types flag:

  swift package generate-documentation --exclude-extended-types --target [target-name]

The 1.3.0 release includes contributions from @​theMomax. Thank you!

v1.2.0: Swift-DocC-Plugin 1.2.0

Compare Source

What's Changed

• You can now generate documentation that includes Swift symbols that extend other modules when building with Swift 5.8 or later. This is an opt-in feature that can be used by passing the --include-extended-types flag:

  swift package generate-documentation --include-extended-types --target [target-name]

• You can now generate documentation that excludes compiler synthesized symbols provided by default implementations of protocol requirements. This is an opt-in, experimental feature that can used by passing the --experimental-skip-synthesized-symbols flag:

  swift package generate-documentation --experimental-skip-synthesized-symbols --target [target-name]

The 1.2.0 release includes contributions from @​finestructure, @​sofiaromorales, and @​theMomax. Thank you!

v1.1.0

Compare Source

• Adds support for snippets.